-
Notifications
You must be signed in to change notification settings - Fork 212
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
document event orchestration attribute type for integration
#722
base: master
Are you sure you want to change the base?
Conversation
* `id` - ID of the integration | ||
* `parameters` | ||
* `parameters` - A list of parameters | ||
* `routing_key` - Routing key that routes to this Orchestration. | ||
* `type` - Type of the routing key. `global` is the default type. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the terraform registry docs, the last two bullets are not displaying as being nested under parameters
. Any idea how to fix?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for fixing this! Hmm not sure why it's not nested properly, but I think there is a TF doc preview tool, let me see if I can find it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@imjaroiswebdev I'm sorry to be tagging you everywhere today but wasn't it you who showed me a markdown preview tool specifically for Terraform docs? Or am I making things up?
@@ -37,9 +37,9 @@ The following arguments are supported: | |||
* `name_filter` - The list of the Event Orchestrations which name match `name_filter` argument. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see name_filter
in the docs on the registry, so I'm not sure why it says name_filter
in the code definition for the event orchestration data source so I'm not sure why this markdown file says name_filter
. Maybe I'm editing the wrong markdown file?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, this is a bit confusing because we have two data sources that look very similar:
pagerduty_event_orchestrations
: lets you pull a list of orchestrations matching the given name filter. This is where it's documented and defined in the codepagerduty_event_orchestration
: returns a single orchestration matching the given name. It's documented and defined in the links that you posted.
Context
While writing terraform to use this provider, I came across a couple documentation glitches that I'm hoping to fix in this PR.